<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class ID3_Frame_LINK</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class ID3_Frame_LINK</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-consts">Constants</a>
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The <em>Linked information</em> frame is used to keep information duplication</p>
<p class="description"><p>as low as possible by linking information from another ID3v2 tag that might  reside in another audio file or alone in a binary file. It is recommended  that this method is only used when the files are stored on a CD-ROM or other  circumstances when the risk of file separation is low.</p><p>Data should be retrieved from the first tag found in the file to which this  link points. There may be more than one LINK frame in a tag, but only one  with the same contents.</p><p>A linked frame is to be considered as part of the tag and has the same  restrictions as if it was a physical part of the tag (i.e. only one  <a href="../../php-reader/ID3/ID3_Frame_RVRB.html">ID3_Frame_RVRB</a> frame allowed, whether it's linked or not).</p><p>Frames that may be linked and need no additional data are  <a href="../../php-reader/ID3/ID3_Frame_ASPI.html">ID3_Frame_ASPI</a>, <a href="../../php-reader/ID3/ID3_Frame_ETCO.html">ID3_Frame_ETCO</a>, <a href="../../php-reader/ID3/ID3_Frame_EQU2.html">ID3_Frame_EQU2</a>,  <a href="../../php-reader/ID3/ID3_Frame_MCDI.html">ID3_Frame_MCDI</a>, <a href="../../php-reader/ID3/ID3_Frame_MLLT.html">ID3_Frame_MLLT</a>, <a href="../../php-reader/ID3/ID3_Frame_OWNE.html">ID3_Frame_OWNE</a>,  <a href="../../php-reader/ID3/ID3_Frame_RVA2.html">ID3_Frame_RVA2</a>, <a href="../../php-reader/ID3/ID3_Frame_RVRB.html">ID3_Frame_RVRB</a>, <a href="../../php-reader/ID3/ID3_Frame_SYTC.html">ID3_Frame_SYTC</a>, the  text information frames (ie frames descendats of  <a href="../../php-reader/ID3/ID3_Frame_AbstractText.html">ID3_Frame_AbstractText</a>) and the URL link frames (ie frames descendants  of <a href="../../php-reader/ID3/ID3_Frame_AbstractLink.html">ID3_Frame_AbstractLink</a>).</p><p>The <a href="../../php-reader/ID3/ID3_Frame_AENC.html">ID3_Frame_AENC</a>, <a href="../../php-reader/ID3/ID3_Frame_APIC.html">ID3_Frame_APIC</a>, <a href="../../php-reader/ID3/ID3_Frame_GEOB.html">ID3_Frame_GEOB</a>  and <a href="../../php-reader/ID3/ID3_Frame_TXXX.html">ID3_Frame_TXXX</a> frames may be linked with the content descriptor  as additional ID data.</p><p>The <a href="../../php-reader/ID3/ID3_Frame_USER.html">ID3_Frame_USER</a> frame may be linked with the language field as  additional ID data.</p><p>The <a href="../../php-reader/ID3/ID3_Frame_PRIV.html">ID3_Frame_PRIV</a> frame may be linked with the owner identifier as  additional ID data.</p><p>The <a href="../../php-reader/ID3/ID3_Frame_COMM.html">ID3_Frame_COMM</a>, <a href="../../php-reader/ID3/ID3_Frame_SYLT.html">ID3_Frame_SYLT</a> and <a href="../../php-reader/ID3/ID3_Frame_USLT.html">ID3_Frame_USLT</a>  frames may be linked with three bytes of language descriptor directly  followed by a content descriptor as additional ID data.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Ryan Butterfield &lt;<a href="mailto:buttza@gmail.com">buttza@gmail.com</a>&gt;</li>
				<li><span class="field">author:</span> Sven Vollbehr &lt;<a href="mailto:svollbehr@gmail.com">svollbehr@gmail.com</a>&gt;</li>
				<li><span class="field">version:</span> $Rev: 105 $</li>
				<li><span class="field">copyright:</span> Copyright (c) 2008 The PHP Reader Project Workgroup</li>
				<li><span class="field">license:</span> <a href="http://code.google.com/p/php-reader/wiki/License">New BSD License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_ID3---Frame---LINK.php.html">/ID3/Frame/LINK.php</a> (line <span class="field">87</span>)
		</p>
		
				
		<pre><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a>
   |
   --<a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a>
      |
      --ID3_Frame_LINK</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-consts">Constants</a>
							
															<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																				
												<div class="method-definition">
											<span class="method-result">ID3_Frame_LINK</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											([<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>&nbsp;<span class="var-name">$reader</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span>&nbsp;<span class="var-name">$options</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getQualifier" title="details" class="method-name">getQualifier</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getTarget" title="details" class="method-name">getTarget</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getUrl" title="details" class="method-name">getUrl</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setQualifier" title="details" class="method-name">setQualifier</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$qualifier</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$identifier</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setTarget" title="details" class="method-name">setTarget</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setUrl" title="details" class="method-name">setUrl</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#__toString" title="details" class="method-name">__toString</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-consts">Constants</a>
							
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../../php-reader/ID3/ID3_Frame.html#var$_data">ID3_Frame::$_data</a></span><br>
							</span>
											</blockquote> 
									<p>Inherited from <span class="classname"><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../../php-reader/ID3/ID3_Object.html#var$_reader">ID3_Object::$_reader</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-vars">Vars</a>
																			<a href="#sec-consts">Constants</a>
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">104</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructs the class with given parameters and parses object related data.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">ID3_Frame_LINK</span>
		<span class="method-name">
			__construct
		</span>
					([<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>&nbsp;<span class="var-name">$reader</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span>&nbsp;<span class="var-name">$options</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>
				<span class="var-name">$reader</span><span class="var-description">: The reader object.</span>			</li>
					<li>
				<span class="var-type">Array</span>
				<span class="var-name">$options</span><span class="var-description">: The options array.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$options</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../php-reader/ID3/ID3_Frame.html#method__construct">ID3_Frame::__construct()</a></dt>
						<dd>Constructs the class with given parameters and reads object related data  from the ID3v2 tag.</dd>
					</dl>
			
	</div>
<a name="methodgetQualifier" id="getQualifier"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getQualifier</span> (line <span class="line-number">149</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the additional data to identify further the tag.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getQualifier
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetTarget" id="getTarget"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getTarget</span> (line <span class="line-number">121</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the target tag identifier.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getTarget
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetUrl" id="getUrl"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getUrl</span> (line <span class="line-number">135</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the target tag URL.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getUrl
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsetQualifier" id="setQualifier"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setQualifier</span> (line <span class="line-number">156</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the additional data to be used in tag identification.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setQualifier
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$qualifier</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$identifier</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$identifier</span><span class="var-description">: The qualifier.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$qualifier</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetTarget" id="setTarget"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setTarget</span> (line <span class="line-number">128</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the target tag identifier.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setTarget
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$target</span><span class="var-description">: The target tag identifier.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetUrl" id="setUrl"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setUrl</span> (line <span class="line-number">142</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the target tag URL.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setUrl
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$url</span><span class="var-description">: The target URL.</span>			</li>
				</ul>
		
			
	</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">__toString</span> (line <span class="line-number">166</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the frame raw data.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			__toString
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../php-reader/ID3/ID3_Frame.html#method__toString">ID3_Frame::__toString()</a></dt>
						<dd>Returns the frame raw data.</dd>
					</dl>
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#method__construct">ID3_Frame::__construct()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodgetFlags">ID3_Frame::getFlags()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodgetIdentifier">ID3_Frame::getIdentifier()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodgetSize">ID3_Frame::getSize()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodhasFlag">ID3_Frame::hasFlag()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodsetData">ID3_Frame::setData()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodsetFlags">ID3_Frame::setFlags()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#methodsetIdentifier">ID3_Frame::setIdentifier()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Frame.html#method__toString">ID3_Frame::__toString()</a></span><br>
											</blockquote>
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../php-reader/ID3/ID3_Object.html">ID3_Object</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#method__construct">ID3_Object::__construct()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodconvertString">ID3_Object::convertString()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methoddecodeSynchsafe32">ID3_Object::decodeSynchsafe32()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methoddecodeUnsynchronisation">ID3_Object::decodeUnsynchronisation()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodencodeSynchsafe32">ID3_Object::encodeSynchsafe32()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodencodeUnsynchronisation">ID3_Object::encodeUnsynchronisation()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodexplodeString8">ID3_Object::explodeString8()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodexplodeString16">ID3_Object::explodeString16()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodgetOption">ID3_Object::getOption()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodgetOptions">ID3_Object::getOptions()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodsetOption">ID3_Object::setOption()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#methodsetOptions">ID3_Object::setOptions()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#method__get">ID3_Object::__get()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ID3/ID3_Object.html#method__set">ID3_Object::__set()</a></span><br>
											</blockquote>
										
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-vars">Vars</a>
														| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Constants</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../php-reader/ID3/ID3_Frame.html">ID3_Frame</a></span></p>
					<blockquote>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constCOMPRESSION">ID3_Frame::COMPRESSION</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constDATA_LENGTH_INDICATOR">ID3_Frame::DATA_LENGTH_INDICATOR</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constDISCARD_ON_FILECHANGE">ID3_Frame::DISCARD_ON_FILECHANGE</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constDISCARD_ON_TAGCHANGE">ID3_Frame::DISCARD_ON_TAGCHANGE</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constENCRYPTION">ID3_Frame::ENCRYPTION</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constGROUPING_IDENTITY">ID3_Frame::GROUPING_IDENTITY</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constREAD_ONLY">ID3_Frame::READ_ONLY</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../php-reader/ID3/ID3_Frame.html#constUNSYNCHRONISATION">ID3_Frame::UNSYNCHRONISATION</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Thu, 01 Jan 2009 14:59:25 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>